<h1>组件模板说明</h1>

<h2>模板文件列表</h2>

<table>
<thead>
<tr>
<th>名称</th>
<th>是否必须</th>
<th>说明</th>
</tr>
</thead>

<tbody>
<tr>
<td>include</td>
<td>可选</td>
<td>头文件目录</td>
</tr>

<tr>
<td>src</td>
<td>可选</td>
<td>源文件目录</td>
</tr>

<tr>
<td>local.mk</td>
<td>可选</td>
<td>组件编译描述文件</td>
</tr>

<tr>
<td>template.yaml</td>
<td>必选</td>
<td>组件版本定义文件</td>
</tr>
</tbody>
</table>

<h2>template.yaml 文件说明</h2>

<p>此文件由 embed 工具读取并维护，用于组件仓库地址和版本管理。</p>

<p><a href="https://code-odm.tuya-inc.com/embed/embeddocs/blob/master/README.md">embed 工具使用说明</a></p>

<p>自定义模板时，此文件必须加上，且文档内的以下内容有特殊含义，不可修改：</p>

<table>
<thead>
<tr>
<th>名称</th>
<th>含义</th>
</tr>
</thead>

<tbody>
<tr>
<td>EmbedTemplate</td>
<td>组件名称</td>
</tr>

<tr>
<td>EMBED_VERSION</td>
<td>组件版本</td>
</tr>

<tr>
<td>GIT_USERNAME</td>
<td>所有者用户名</td>
</tr>

<tr>
<td>GIT_USER_EMAIL</td>
<td>所有者邮箱</td>
</tr>

<tr>
<td>GIT_ADDRESS</td>
<td>仓库地址</td>
</tr>

<tr>
<td>EMBED_VERSION</td>
<td>GIT TAG</td>
</tr>
</tbody>
</table>

<h2>local.mk 说明</h2>

<p>此文件非必要文件，当采用 <a href="https://code.registry.wgine.com/embed_ci_space_group/xmake/blob/master/README.md">xmake 编译框架</a>时，使用此文件。</p>

<p>local.mk 语法参照自 <a href="https://developer.android.google.cn/ndk/guides/android_mk">NDK Android.mk 语法</a>。</p>
